Fix GA4 event data on taxon pages #3896
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
andysellick
reviewed
Dec 10, 2024
app/views/taxons/show.html.erb
Outdated
| @@ -62,7 +62,7 @@ | |||
| } | |||
| %> | |||
| <%= content_tag(:div, data: ga4_data) do %> | |||
| <%= render(partial: section[:partial_template], locals: { section: section }) %> | |||
| <%= render(partial: section[:partial_template], locals: { section: section, disable_ga4: true }) %> | |||
There was a problem hiding this comment.
Putting a false default into the partials seems sensible, but is there a situation where that isn't overridden by this line?
There was a problem hiding this comment.
I could not see any other uses of the section partials outside of the taxon page where the change is required.
My initial option was to hardcode disable_ga4: true in each section partial, happy to go with this approach if preferred
There was a problem hiding this comment.
I think that might be simpler - otherwise it implies that this is necessary because some other part of the code doesn't pass true, which isn't correct. We can always extend it later if needed 👍
There was a problem hiding this comment.
Agreed, thanks Andy, I've made this change
Set `disable_ga4` to true for the document-list component used to render each section of the taxon page. This fixes an issue on taxon pages (/education for example), where link clicks would fire 2 events instead of 1, both of which were missing some event data.
MartinJJones
force-pushed
the
fix-ga4-duplicate-event
branch
from
9c01f80 to
3a7aec6
Compare
andysellick
approved these changes
Dec 10, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What
Set
disable_ga4to true for the document-list component used to render each section on a taxon page.Why
This fixes an issue on taxon pages (/education for example), where link clicks would fire 2 events instead of 1, both of which were missing some data.
Event data changes
The data below is sent to GA after clicking the "Student finance for undergraduates" link on this page - https://www.gov.uk/education/funding-and-finance-for-students#/education/student-grants-bursaries-scholarships
Before
{ "event": "event_data", "event_data": { "event_name": "navigation", "external": "false", "index": { "index_link": "2" }, "link_domain": "https://www.gov.uk", "method": "command/win click", "text": "Student finance for undergraduates", "type": "document list", "url": "/student-finance" }, "govuk_gem_version": "46.2.0", "timestamp": "1733824170576" } { "event": "event_data", "event_data": { "event_name": "navigation", "external": "false", "index": { "index_link": "2" }, "link_domain": "https://www.gov.uk", "method": "command/win click", "text": "Student finance for undergraduates", "type": "document list", "url": "/student-finance" }, "govuk_gem_version": "46.2.0", "timestamp": "1733824170581" }After
Only 1 event is fired and information for "index_section", "index_section_count" and "section" is now included.
{ "event": "event_data", "event_data": { "event_name": "navigation", "external": "false", "index": { "index_link": "2", "index_section": "1", "index_section_count": "8" }, "index_total": "6", "link_domain": "https://www.gov.uk", "method": "command/win click", "section": "Services", "text": "Student finance for undergraduates", "type": "document list", "url": "/student-finance" }, "govuk_gem_version": "46.2.0", "timestamp": "1733824112924" }